-
Notifications
You must be signed in to change notification settings - Fork 0
Visualize Examples #14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #14 +/- ##
=======================================
Coverage 76.23% 76.23%
=======================================
Files 3 3
Lines 101 101
=======================================
Hits 77 77
Misses 24 24 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds visualizations to the README documentation by including PNG images and GIF animations for each code example. The changes make the documentation more user-friendly by showing what the examples actually look like when rendered. Key updates include:
- Added 9 image files (8 PNGs, 1 GIF reference) to visualize examples
- Updated all code examples with improved styling parameters (margins, sizing modes, dimensions)
- Added image references after each example section
Reviewed changes
Copilot reviewed 1 out of 11 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Updated code examples with better styling and added image references for visualizations; contains 3 spelling errors and 1 misleading comment |
| docs/assets/images/*.png | New PNG image files for visualizing examples (binary files, cannot review content directly) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
|
Note. I've changed This PR should be ready to review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
The README contains a lot of examples. But there are no visualization, i.e. users cannot see what this really is.
This PR adds the missing visualizations.
Please note some of the code examples will have to be adjusted to look attractive and be useful.
You can preview the updated README here.